PrizmDoc v12.1 - January 5, 2017
Health Status
| API Reference > PrizmDoc Server RESTful API > Health Status |
Returns the following HTTP status codes to reflect the overall health of the PrizmDoc Server:
This URL is intended to provide a quick, easily parseable indication as to the health of PrizmDoc Server. For more information about the current health, use GET /Service/Current/Info.
Http Method
GET
Resource URL
/PCCIS/V1/Service/Current/Health
Parameters
None
Request Body
None
Response Body
| OK | for HTTP status code 200 |
| None/Empty | for HTTP status code 500 |
| Example |
Copy Code
|
|---|---|
GET http://localhost:18681/PCCIS/V1/Service/Current/Health
|
|
| Example Response |
Copy Code
|
|---|---|
200 OK |
|
This API returns a JSON object indicating the health of PrizmDoc Server.
Http Method
GET
Resource URL
/PCCIS/V1/Service/Current/Info
Parameters
None
Request Body
None
Response Body
If successful, this method returns the following properties:
|
Property Name |
Value |
Description |
|
serviceStatus |
String |
Status of PrizmDoc Server:
|
|
licenseStatus |
String |
Information about the PrizmDoc license.
|
| instances[].serviceStatus | String | Status of the PrizmDoc Server used for Viewing. |
| instances[].serviceInstallerVersion | String | Version of the installer used to install PrizmDoc Server. |
| instances[].pccisVersion | String | Version of the PrizmDoc Server used for Viewing. |
| instances[].runtimeVersion | String | .NET runtime version supporting the PrizmDoc Server used for Viewing. |
| instances[].operatingSystem | String | Operating System of the server on which PrizmDoc Server are running. |
| instances[].startTime | String | Last recorded time the PrizmDoc Server were started. Time is reported in UTC and is ISO-8601 format. |
| instances[].instanceId | String | Host name of the server running PrizmDoc Server. |
| instances[].childServices | Array | Name and status for each individual child PrizmDoc Server. |
| instances[].childServices[].name | String | Name of the child PrizmDoc Server. |
|
instances[].childServices[].status |
String |
Status of the child PrizmDoc Server:
|
| Example |
Copy Code
|
|---|---|
GET http://localhost:18681/PCCIS/V1/Service/Current/Info
|
|
| Example Response |
Copy Code
|
|---|---|
{
"serviceStatus": "running",
"licenseStatus": "licensed as 'PCC' ",
"instances": [
{
"serviceStatus": "running",
"serviceInstallerVersion": "XX.X.XX.XXX",
"pccisVersion": "XX.X.XX.XXXX",
"runtimeVersion": "4.0.30319.34014",
"operatingSystem": "Microsoft Windows NT 6.3.9600.0",
"startTime": "1971-01-01T00:00:00.0Z",
"instanceId": "myhostname",
"childServices": [
{
"name": "PCC Error Reporting Service",
"serviceStatus": "running"
},
{
"name": "PCC Imaging Conversion Service",
"serviceStatus": "running",
"version": "X.X.XXXX.XXXX"
},
{
"name": "PCC PDF Processing Service",
"serviceStatus": "running"
},
{
"name": "PCC Raster Conversion Service",
"serviceStatus": "running",
"version": "X.X.XXXX.XXXX"
},
{
"name": "PCC Vector Conversion Service",
"serviceStatus": "running",
"version": "X.X.XXXX.XXXX"
},
{
"name": "PCC Html Conversion Service",
"serviceStatus": "running",
"version": "X.X.XXXX.XXXX"
},
{
"name": "PCC Work File Service",
"serviceStatus": "running",
"version": "X.X.X"
},
{
"name": "PCC Office Conversion Service",
"serviceStatus": "running",
"version": "X.XX.XXXX.XXXX"
},
{
"name": "PCC Format Detection Service",
"serviceStatus": "running"
},
{
"name": "PCC AutoRedaction Service",
"serviceStatus": "running"
},
{
"name": "PCC Redaction Service",
"serviceStatus": "running",
"version": "X.X.X"
},
{
"name": "PCC Email Processing Service",
"serviceStatus": "running"
},
{
"name": "PCC Email Conversion Service",
"serviceStatus": "running",
"version": "X.X.XXXX.XXXX"
},
{
"name": "PCC Content Conversion Service",
"serviceStatus": "running"
},
{
"name": "configuration-service",
"serviceStatus": "running"
},
{
"name": "licensing-service",
"serviceStatus": "running"
},
{
"name": "health-service",
"serviceStatus": "running"
}
]
}
]
}
|
|